Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Corrected the bug in examples for iam_instance_profile #1827

Closed
wants to merge 1 commit into from
Closed

Corrected the bug in examples for iam_instance_profile #1827

wants to merge 1 commit into from

Conversation

HVbajoria
Copy link

SUMMARY

In this pull request, I have corrected the bug because of which it was pointing to iam_instance_profile_info examples instead of itself. It Fixes #1811

ISSUE TYPE
  • Bugfix Pull Request
COMPONENT NAME

NA

ADDITIONAL INFORMATION

I just corrected the file path in the file.

Could you please check once? Will be happy to learn and contribute more.

@github-actions
Copy link

Docs Build 📝

Thank you for contribution!✨

The docsite for this PR is available for download as an artifact from this run:
https://github.com/ansible-collections/amazon.aws/actions/runs/6617345748

You can compare to the docs for the main branch here:
https://ansible-collections.github.io/amazon.aws/branch/main

File changes:

  • M collections/amazon/aws/iam_instance_profile_module.html
Click to see the diff comparison.

NOTE: only file modifications are shown here. New and deleted files are excluded.
See the file list and check the published docs to see those files.

diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/iam_instance_profile_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/iam_instance_profile_module.html
index 8f448e9..e2c87af 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/iam_instance_profile_module.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/iam_instance_profile_module.html
@@ -399,16 +399,16 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-iam-inst
 <section id="examples">
 <h2><a class="toc-backref" href="#id5" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
 <div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Find all existing IAM instance profiles</span>
-<span class="w">  </span><span class="nt">amazon.aws.iam_instance_profile_info</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">amazon.aws.iam_instance_profile</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result</span>
 
 <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Describe a single instance profile</span>
-<span class="w">  </span><span class="nt">amazon.aws.iam_instance_profile_info</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">amazon.aws.iam_instance_profile</span><span class="p">:</span>
 <span class="w">    </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">MyIAMProfile</span>
 <span class="w">  </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result</span>
 
 <span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Find all IAM instance profiles starting with /some/path/</span>
-<span class="w">  </span><span class="nt">amazon.aws.iam_instance_profile_info</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">amazon.aws.iam_instance_profile</span><span class="p">:</span>
 <span class="w">    </span><span class="nt">prefile</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/some/path/</span>
 <span class="w">  </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result</span>
 </pre></div>

@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/539266c575624fd8a0d0c6a4a40c8bbd

✔️ ansible-galaxy-importer SUCCESS in 5m 29s
✔️ build-ansible-collection SUCCESS in 15m 17s
✔️ ansible-test-splitter SUCCESS in 5m 18s
✔️ integration-amazon.aws-1 SUCCESS in 8m 12s
Skipped 43 jobs

tremble
tremble requested changes Oct 24, 2023
View reviewed changes
Copy link
Contributor

@tremble tremble left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking the time to submit this PR. These examples were valid for iam_instance_profile_info which is designed for reading/listing profiles. However they're not valid for iam_instance_profile as it is designed for creating/modifying/deleting profiles.

It would probably be good to add 4 examples:

  • Adding a profile with no path
  • Adding a profile with a path
  • Setting the role for a profile
  • Deleting a profile

You can probably copy some of the tasks from our integration tests as examples - https://github.com/ansible-collections/amazon.aws/blob/main/tests/integration/targets/iam_instance_profile/tasks/main.yml

@HVbajoria
Copy link
Author

Thanks for taking the time to submit this PR. These examples were valid for iam_instance_profile_info which is designed for reading/listing profiles. However they're not valid for iam_instance_profile as it is designed for creating/modifying/deleting profiles.

It would probably be good to add 4 examples:

  • Adding a profile with no path
  • Adding a profile with a path
  • Setting the role for a profile
  • Deleting a profile

You can probably copy some of the tasks from our integration tests as examples - https://github.com/ansible-collections/amazon.aws/blob/main/tests/integration/targets/iam_instance_profile/tasks/main.yml

Could you please guide me how to do this?

abikouo pushed a commit to abikouo/amazon.aws that referenced this pull request Oct 24, 2023
@alialkhalidi
feat: add mq inventory plugin; addresses ansible-collections#1827 (an…
5f96421 
…sible-collections#1831)

feat: add mq inventory plugin; addresses ansible-collections#1827

SUMMARY
MQ broker inventory source
ISSUE TYPE

New Module Pull Request

COMPONENT NAME
aws_mq
ADDITIONAL INFORMATION
EXAMPLE USAGE:
plugin: aws_mq
regions:
  - ca-central-1
keyed_groups:
  - key: engine_type
    prefix: mq
compose:
  app: 'tags.Applications|split(",")'
hostvars_prefix: aws_
hostvars_suffix: _mq

Reviewed-by: Alina Buzachis
Reviewed-by: alialkhalidi
Reviewed-by: Mark Chappell
Reviewed-by: Mike Graves <[email protected]>
@HVbajoria HVbajoria closed this by deleting the head repository Nov 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tremble tremble tremble requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Invalid examples in iam_instance_profile
2 participants
@HVbajoria @tremble